Disposes of the GDevice structure for a video device.

OSErr DMDisposeDisplay (
    GDHandle disposeDevice, 
    Handle displayState
);

disposeDevice

A handle to the GDevice structure for a video device you want to delete.

displayState

If your application called DMBeginConfigureDisplays, you must pass the displayState handle obtained. Otherwise pass NULL in this parameter.

function result

A result code.

DISCUSSION

The DMDisposeDisplay function disposes of a GDevice structure, releases the space allocated for it, and disposes of all the data structures allocated for it. The Display Manager calls this function when appropriate.

SPECIAL CONSIDERATIONS

Because this function may move or purge memory blocks or access handles, you cannot call it at interrupt time.

Generally, your application should not use this function, but should instead allow system software to maintain the device list. This function is described here for completeness only.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.5 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.5 and later.

© 2000 Apple Computer, Inc. — (Last Updated 3/8/2000)